docs: trim user-facing tutorial, sdk, testing and scripts docs - #602
Merged
Conversation
Retarget tutorial-first-module.md from the removed stop-loss/cow-api walkthrough to the shipped price-alert example (block subscription, chain read, ABI decode) with current crate names and the #[nexum_sdk::module] macro surface; drop the aspirational time-budget framing. Delete qa-signoff.md, a dated pre-review sign-off snapshot. testing-runtime-harness.md: drop the nonexistent shepherd-sdk-test mock surface (module logic tests use nexum-sdk-test plus videre-test's transport mocks), repoint the sdk.md anchor, trim the intro. scripts/README.md: purge em dashes, drop the deleted e2e-prep.md reference and the stale stop-loss note. Part of #598.
mfw78
force-pushed
the
docs/598-user-docs
branch
from
July 25, 2026 03:12
b27b3ca to
3ae1339
Compare
Hard-wrapped prose churns diffs: a one-word edit reflows the whole paragraph. Join each paragraph onto a single logical line and let it soft-wrap. Content unchanged (word and heading counts preserved); code fences, tables, lists, blockquotes and headings untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Trim the user-facing docs to the house standard (terse, factual, British -ize, no em dashes) as part of the #598 cruft sweep.
Retarget
docs/tutorial-first-module.mdfrom the removed stop-loss / cow-api walkthrough to the shippedprice-alertexample: block subscription,chainread with ABI decode,[config]-driven behaviour, current crate names (nexum-sdk,nexum-sdk-test) and the#[nexum_sdk::module]macro surface. Dropped the aspirational four-hour time-budget framing and the per-section time estimates.Delete
docs/qa-signoff.md, a dated (2026-06-17) pre-review sign-off snapshot.docs/testing-runtime-harness.md: drop the nonexistentshepherd-sdk-testmock surface (module-logic tests usenexum-sdk-test, venue-facing logic addsvidere-test's transport mocks), repoint thesdk.mdcompanions anchor, trim the intro essay.scripts/README.md: purge em dashes, drop the reference to the deleteddocs/operations/e2e-prep.md, and remove the stale stop-loss note.docs/sdk.mdleft unchanged: already terse, and itsnexum-sdk/videre-sdksplit description, the "nothing re-exported between them" claim,keeper::retry_action, and the rustdoc-generation command all verify against the crates.Why
The tutorial walked a stop-loss module that no longer exists and linked pre-rename crates (
shepherd-sdk,shepherd-sdk-test) and the removedcow-apihost path, so it could not be followed. The other files carried a deleted mock surface, a dead runbook link, a dated snapshot, and em dashes.Testing
Markdown-only area: verified nothing links to the deleted
docs/qa-signoff.mdordocs/operations/e2e-prep.md; every command, crate, module path, and macro in the rewritten tutorial checked against dev/m1 (price-alertsource,nexum-clipositional-plus---engine-configsurface,#[nexum_sdk::module]expansion,nexum_sdk_test::MockHost). No em dashes remain in the touched files.AI Assistance
Documentation-only sweep; verification ran was the link and command/crate/path cross-checks against the dev/m1 worktree described above.
Deviations flagged
stop-lossmodule is absent frommodules/(dev/m1 tip), yet the E2E shell scripts still reference it:scripts/e2e-onchain.sh:19,22,145andscripts/env-template:24,44. These.sh/template files are outside this area's editable paths (onlyscripts/README.mdis owned here), so the residual references are left for the scripts owner; the twap-monitor and ethflow-watcher markers the scripts primarily exercise do still exist.Part of #598.